Change User's Status

Allow or Block a user on the system

Method

/API2/access/toggleEnableUser

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

toggleUserApiData

Object Type

ToggleUserApiData

Description

The toggle object to indicate the user state in the system.

Output Response

Successful Result Code

200

Response Type

ModifiedItemsResult

Description of Response Type

Generic API response object with success or failure flag and related messages.

Notes

This function enables or disables a user's account in the system. Requires the user's ID. Use 'getUsersByName' to find relevant users